概述
SView Designer Control为OCX控件提供三维模型基本的浏览、模型属性操作、基本三维对象操作、动画播放等功能的实现接口,可实现基本的 三维模型展示功能,以便于用户个性化定制属于自己的产品。文档主要介绍了OCX控件提供的接口说明。SView Designer Control控件集成说明的介绍请查看SView Designer Control 集成说明文档。
接口列表
基本浏览
打开本地文件
方法
void Open(SHORT viewID, BSTR fileName)
说明
打开本地文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
fileName | 是 | 本地文件路径 |
返回值
无
备注
D:\\1.svl 打开D盘下的1.svl文件
打开空文件
方法
BOOL OpenBlankFile(short viewID)
说明
打开空文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
TRUE-成功FALSE-失败
备注
无
关闭模型文件
方法
void Close(SHORT viewID)
说明
关闭模型文件
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
返回值
无
备注
去掉原有参数bSaveFile,保存模型,请调用Save接口。
保存模型
方法
VARIANT_BOOL Save(SHORT viewID, BSTR plcPath, BSTR strFilePath)
说明
保存当前模型或者部分装配到指定路径
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配路径或者"" |
strFilePath | 是 | 文件路径 |
返回值
TRUE-成功FALSE-失败
备注
若plcPath为null或者"",保存整个模型,否则保存单个或者多个装配
选择模型
方法
void SelectModels(SHORT viewID, BSTR plcPath, VARIANT_BOOL bDeslectAll)
说明
选择指定的模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 输入参数,模型实例ID (如:PATH|0|2;PATH|0|5 多个用分号隔开) |
bDeslectAll | 是 | 是否取消已有选择 |
返回值
无
备注
无
取消所有选中
方法
void DeselectAll(SHORT viewID)
说明
根据名称显隐装配
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
获取选择的模型
方法
BSTR GetSelectedModels(SHORT viewID)
说明
获取选择的模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
选择模型ID数组(如:PATH|0|3,ELBOW_FIT;PATH|0|4,CLAMP)
备注
无
显隐模型
方法
void SetModelVisible(SHORT viewID,BSTR plcPath,VARIANT_BOOL bshow)
说明
根据模型实例ID,显隐模型
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
plcPath | 是 | 模型实例路径(多个用逗号隔开,如PATH|0|1,PATH|0|3) |
bshow | 是 | 显示/隐藏状态 |
返回值
无
备注
无
设置模型颜色
方法
void SetModelColor(SHORT viewID, BSTR plcPath, BSTR color)
说明
设置模型颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
color | 是 | 要改变的颜色 |
plcPath | 是 | 对象ID(如:PATH|0|1) |
返回值
无
备注
color:0xRRGGBB
设置相机类型
方法
void SetCameraType(SHORT viewID, SHORT nOperType)
说明
设置相机类型
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
nOperType | 是 | 1,缩放;3,自旋转。 |
返回值
无
备注
无
设置对象的操作类型
方法
void SetObjOperType(SHORT viewID, SHORT nOperType)
说明
设置对象的操作类型
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
nOperType | 是 | 操作类型:0,自由观察;1,动态观察;2,约束观察 |
返回值
无
备注
无
获取模型颜色
方法
BSTR GetModelColor(SHORT viewID, BSTR plcPath)
说明
根据配置路径获取模型的颜色
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 模型配置路径 |
返回值
颜色值: 0xRRGGBB。
备注
无
设置装配材质
方法
VARIANT_BOOL SetModelMaterial(SHORT viewID, BSTR plclPaths, BSTR materialName)
说明
设置装配材质。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plclPaths | 是 | 模型配置路径集合,由";"隔开 |
materialName | 是 | 材质名称,包括模型材质和模板材质,如“materialTemplate_SVLXRender7|4769” |
返回值
TRUE,设置成功
备注
无
复位视口
方法
void RestoreView(SHORT viewID)
说明
复位视口。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
自适应视图
方法
void FitModelViewZoom(SHORT viewID)
说明
自适应视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
零件自适应
方法
void FitModelZoom(SHORT viewID, BSTR plcPath)
说明
零件自适应
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
无
备注
无
撤销
方法
void Undo(SHORT viewID)
说明
撤销
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
重做
方法
void Redo(SHORT viewID)
说明
重做
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
取消选中模型
方法
void DeselectModels(SHORT viewID, BSTR plcPaths)
说明
取消选中指定配置路径装配
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
plcPaths | 是 | 配置路径集合,由";"隔开 |
返回值
无
备注
无
根据属性名称获取指定装配的属性值
方法
BSTR GetModelProperty(SHORT viewID, BSTR plcPath, BSTR propertyName)
说明
根据属性名称获取指定装配的自定义属性值
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 零组件配置路径(如:PATH|0|2) |
propertyName | 是 | 属性名称 |
返回值
属性值
备注
无
添加自定义属性
方法
VARIANT_BOOL SetModelProperty(SHORT viewID, BSTR plcPath, BSTR propertyName, BSTR propertyValue)
说明
添加自定义属性
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 零组件配置路径 |
propertyName | 是 | 属性名称 |
propertyValue | 是 | 属性值 |
返回值
TRUE-成功FASLE-失败
备注
无
拾取对象
方法
void SelectShapes(SHORT viewID, BSTR shapeIDs, SHORT objType)
说明
拾取指定类型指定ID的对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
shapeIDs | 是 | 对象ID集合,由“;”隔开 |
objType | 是 | 对象类型,1=批注、2=测量、3=PMI、4=热点、5=几何 |
返回值
无
备注
无
删除自定义属性
方法
VARIANT_BOOL RemoveModelProperty(SHORT viewID, BSTR plcPath, BSTR propertyName)
说明
删除自定义属性
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
propertyName | 是 | 属性名称 |
返回值
TRUE-成功FASLE-失败
备注
无
取消拾取对象
方法
void DeselectShapes(SHORT viewID, BSTR shapeIDs, SHORT objType)
说明
取消拾取对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
shapeIDs | 是 | 对象ID集合,由“;”隔开 |
objType | 是 | 对象类型,1=批注、2=测量、3=PMI、4=热点、5=几何 |
返回值
无
备注
无
生成快照
方法
VARIANT_BOOL Snapshot(SHORT viewID, BSTR filePath, BSTR fileType, VARIANT_BOOL bCover, LONG width, LONG height)
说明
生成快照
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
filePath | 是 | 快照路径 |
fileType | 是 | 文件格式类型 |
bCover | 是 | 是否覆盖 |
width | 是 | 快照宽度 |
height | 是 | 快照高度 |
返回值
TRUE-成功FASLE-失败
备注
无
自定义截图
方法
VARIANT_BOOL CustomScreenShot()
说明
自定义截图
参数
无
返回值
TRUE-成功FASLE-失败
备注
无
获取选中对象
方法
BSTR GetSelectedShapes(SHORT viewID, SHORT objType)
说明
获取选中对象
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
objType | 是 | 对象类型,1=批注、2=测量、3=PMI、4=热点、5=几何 |
返回值
对象ID,由“;”隔开。
备注
无
拾取但不选择
方法
BSTR PickShape(SHORT viewID, SHORT x, SHORT y, SHORT pickType)
说明
拾取但不选择
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
x | 是 | 屏幕点x坐标 |
y | 是 | 屏幕点y坐标 |
pickType | 是 | 拾取类型:0=顶点,1=边,2=面,3=体,4=模型 |
返回值
对象的配置路径。
备注
无
设置基本视图
方法
void SetPerspective(SHORT viewID, SHORT viewType)
说明
设置基本视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
viewType | 是 | viewType:视图类型 0 前视图 1 后视图 2 右视图 3 左视图 4 仰视图 5 俯视图 6 轴测图 8 后轴测图 |
返回值
无
备注
无
显示关于对话框
方法
void ShowAbout()
说明
显示关于对话框
参数
无
返回值
无
备注
无
设置是否显示选中模型的包围盒标志
方法
void SetBoundingBoxVisible(SHORT viewID, VARIANT_BOOL bShow)
说明
设置是否显示选中模型的包围盒标志
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
bShow | 是 | 显示/隐藏标志 |
返回值
无
备注
无
设置观察模式
方法
void SetOrbitMode(SHORT viewID, SHORT mode)
说明
设置观察模式
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
mode | 是 | 观察模式:0, 自由观察; 1, 动态观察 ;2 约束观察 |
返回值
无
备注
无
获取装配的所有自定义属性
方法
BSTR GetModelProperties(SHORT viewID, BSTR plcPath)
说明
获取装配的所有自定义属性
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
各属性的json串。
备注
无
设置装配的多个自定义属性
方法
void SetModelProperties(SHORT viewID, BSTR plcPath, BSTR jsonStr)
说明
设置装配的多个自定义属性
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
jsonStr | 是 | 自定义属性的json串。 |
返回值
各属性的json串。
备注
无
设置漫游参数
方法
void SetWalkThroughParameters(SHORT viewID, BSTR jsonPar)
说明
设置漫游参数,参数使用json格式。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
jsonPar | 是 | 漫游参数 |
返回值
无
备注
无
获取漫游参数
方法
BSTR GetWalkThroughParameters(SHORT viewID)
说明
获取漫游参数,返回值为json格式。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
json格式的漫游参数。
备注
无
关闭漫游
方法
void CancelWalkThrough(SHORT viewID)
说明
关闭漫游。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
设置对象颜色
方法
void SetColor(SHORT viewID, BSTR shapeIDs, SHORT shapeType, BSTR color)
说明
设置指定类型指定ID对象的颜色。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
shapeIDs | 是 | 对象ID集合,由“;”隔开。 |
shapeType | 是 | 对象类型,如:1=批注、2=测量、 3=PMI、4=热点、5=几何等 |
color | 是 | 颜色,格式0xRRGGBB。 |
返回值
无
备注
无
获取对象颜色
方法
BSTR GetColor(SHORT viewID, BSTR shapeID, SHORT shapeType)
说明
获取指定类型指定ID对象的颜色。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
shapeIDs | 是 | 对象ID集合,由“;”隔开。 |
shapeType | 是 | 对象类型,如:1=批注、2=测量、 3=PMI、4=热点、5=几何等 |
返回值
颜色,格式0xRRGGBB。
备注
无
设置对象显隐状态
方法
void SetVisible(SHORT viewID, BSTR shapeID, SHORT shapeType, VARIANT_BOOL visible)
说明
设置指定类型指定ID对象的显隐状态。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
shapeIDs | 是 | 对象ID集合,由“;”隔开。 |
shapeType | 是 | 对象类型,如:1=批注、2=测量、 3=PMI、4=热点、5=几何等 |
visible | 是 | 显隐状态,若为false,则隐藏。 |
返回值
无
备注
无
获取对象显隐状态
方法
VARIANT_BOOL GetVisible(SHORT viewID, BSTR shapeID, SHORT shapeType)
说明
获取指定类型指定ID对象的显隐状态。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
shapeIDs | 是 | 对象ID集合,由“;”隔开。 |
shapeType | 是 | 对象类型,如:1=批注、2=测量、 3=PMI、4=热点、5=几何等 |
返回值
显隐状态,若为false,则隐藏。
备注
无
获取模型显隐状态
方法
VARIANT_BOOL GetModelVisible(SHORT viewID, BSTR plcPath)
说明
获取模型的显隐状态。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径集合,由“;”隔开。 |
返回值
显隐状态,若为false,则隐藏。
备注
无
设置对象透明度
方法
void SetAlpha(SHORT viewID, BSTR shapeIDs, SHORT shapeType, FLOAT alpha)
说明
获取模型的显隐状态。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
shapeIDs | 是 | 对象ID集合,由“;”隔开。 |
shapeType | 是 | 对象类型,如:1=批注、2=测量、 3=PMI、4=热点、5=几何等 |
alpha | 是 | 透明度,值在0-1之间 |
返回值
无
备注
无
获取对象透明度
方法
FLOAT GetAlpha(SHORT viewID, BSTR shapeIDs, SHORT shapeType)
说明
获取指定类型指定ID对象的显隐状态。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
shapeIDs | 是 | 对象ID集合,由“;”隔开。 |
shapeType | 是 | 对象类型,如:1=批注、2=测量、 3=PMI、4=热点、5=几何等 |
返回值
对象透明度,值在0-1之间。
备注
无
设置摄像机状态值
方法
VARIANT_BOOL SetCameraStates(SHORT viewID, SHORT cameraID, BSTR cameraState)
说明
设置摄像机状态值。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
cameraID | 是 | 摄像机ID |
cameraState | 是 | 摄像机状态,json格式。 |
返回值
TRUE, 设置成功。
备注
无
获取摄像机状态值
方法
BSTR GetCameraStates(SHORT viewID, SHORT cameraID)
说明
获取摄像机状态值。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
cameraID | 是 | 暂时不用 |
返回值
摄像机状态,json格式。
备注
无
根据json创建灯光
方法
BSTR CreateLights(SHORT viewID, BSTR lightJson)
说明
根据json创建灯光。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
lightJson | 是 | json格式的灯光数据。 |
返回值
灯光ID集合,由“;”隔开。
备注
无
设置背景模式
方法
void SetBackgroundType(SHORT viewID, SHORT type)
说明
设置背景模式。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
type | 是 | 背景类型,可能有组合,1=渐变色,2=图片,4=天空盒,8=背景透明,16=水印 |
返回值
无
备注
无
获取背景模式
方法
SHORT GetBackgroundType(SHORT viewID)
说明
获取背景模式。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
背景类型,可能有组合,1=渐变色,2=图片,4=天空盒,8=背景透明,16=水印。
备注
无
设置背景颜色
方法
void SetBackgroundColor(SHORT viewID, BSTR topColor, BSTR bottomColor)
说明
设置背景颜色。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
topColor | 是 | 顶部颜色,格式:0xRRGGBB。 |
bottomColor | 是 | 底部颜色,格式:0xRRGGBB。 |
返回值
无
备注
无
获取背景颜色
方法
BSTR GetBackgroundColor(SHORT viewID)
说明
获取背景颜色。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
格式:顶部颜色;底部颜色,其中颜色格式为0xRRGGBB。
备注
无
设置背景图片路径
方法
void SetBackgroundImage(SHORT viewID, BSTR imagePath)
说明
设置背景图片路径。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
imagePath | 是 | 背景图片全路径 |
返回值
无
备注
无
获取背景图片路径
方法
BSTR GetBackgroundImage(SHORT viewID)
说明
获取背景图片路径。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
背景图片全路径。
备注
无
设置天空盒图片路径
方法
void SetSkyboxImages(SHORT viewID, BSTR imagePath)
说明
设置天空盒图片路径。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
imagePath | 是 | 天空盒图片路径 |
返回值
无
备注
无
设置面板显隐性
方法
VARIANT_BOOL ShowPanel(BSTR panelName, VARIANT_BOOL bVisible)
说明
设置面板显隐性。
参数
参数 | 是否必须 | 说明 |
---|---|---|
panelName | 是 | 面板名称如下:装配:AssemblyPanel, 视图:ViewPanel, 属性:PropertyPanel, 图层:LayerPanel, 热点:HotspotPanel, 动画面板:AnimationPanel, 组面板:GroupPanel, 协同面板:TeamworkPanel, 帧编辑器面板:KeyFrameEditPanel, |
bVisible | 是 | 显隐状态 |
返回值
TRUE,执行成功。
备注
无
设置工具栏显隐性
方法
VARIANT_BOOL ShowToolbar(BSTR toolbarName, VARIANT_BOOL bVisible)
说明
设置工具栏显隐性。
参数
参数 | 是否必须 | 说明 |
---|---|---|
toolbarName | 是 | 暂时不用 |
bVisible | 是 | 显隐状态 |
返回值
TRUE, 成功。
备注
无
全屏显示
方法
void FullScreen(VARIANT_BOOL bFullScreen)
说明
全屏显示。
参数
参数 | 是否必须 | 说明 |
---|---|---|
bFullScreen | 是 | true,全屏显示;false,退出全屏显示。 |
返回值
无
备注
无
获取版本号
方法
BSTR GetVersion(SHORT type)
说明
获取不同对象的获取版本号。
参数
参数 | 是否必须 | 说明 |
---|---|---|
type | 是 | 0:sview版本号;1:M3D版本号;2:svlx版本号 |
返回值
版本号。
备注
无
设置模型透明度
方法
void SetModelAlpha(SHORT viewID, BSTR plcPaths, FLOAT alpha)
说明
设置模型透明度。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
plcPaths | 是 | 模型配置路径集合,由“;”隔开。 |
alpha | 是 | 透明度,值在0-1之间。 |
返回值
无
备注
无
获取模型透明度
方法
FLOAT GetModelAlpha(SHORT viewID, BSTR plcPath)
说明
获取模型透明度。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
plcPath | 是 | 模型配置路径 |
返回值
透明度,值在0-1之间。
备注
无
设置多个SView配置
方法
void SetParameters(BSTR json)
说明
设置多个SView配置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
json | 是 | 多个参数json字符串,如: { "GLES":"2", "coordinate":"True" "antialiasing":"0", "isPlayScene":"True" } |
返回值
无
备注
无
获取多个SView配置
方法
BSTR GetParameters()
说明
获取多个SView配置。
参数
无
返回值
json格式SView参数。
备注
各json属性以及释义如下所示:
属性 | 释义 |
---|---|
language | 语言:0,中文;1,英文 |
drawDataBufferType | 缓存设置:0,内存优先;1,显存优先 |
GLES | GLES版本:1,ES1;2,ES2 |
exampleFile | 是否开启示例文档:true,开启 |
isPreview | 是否开启预显:true,开启 |
defaultlayout | 是否使用默认面板布局:true,开启 |
coordinate | 是否显示坐标系:true,开启 |
browseframe | 是否显示浏览帧数:true,开启 |
showBoundingBox | 是否显示包围盒:true,开启 |
renderMode | 渲染模式:0,着色;1,半透明;3,线框;4,边着色;5,网格 |
antialiasing | 反锯齿:0-10 |
playSpeed | 播放速度:倍速,默认为1倍速 |
isPlayScene | 播放动画时,是否切换场景 |
isPlayShowHide | 播放动画时,是否使用显隐效果 |
isPlayColor | 播放动画时,是否使用颜色效果 |
isPlayPic | 播放动画时,是否使用图片插入效果 |
isPlayClipPlane | 播放动画时,是否使用剖切效果 |
isPlayPosRot | 播放动画时,是否使用位移旋转效果 |
isClearClipPlane | 是否开启清除非动画中的剖面,TRUE,开启 |
autoKeyFrameLength | 自动关键帧长度,默认为20 |
isAutoSave | 是否开启自动保存动画,TRUE,开启 |
isShowTrochoid | 动画播放时是否显示轨迹线,TRUE,显示轨迹线 |
username | 批注用户名称 |
department | 批注部门名称 |
role | 批注角色名称 |
removeMode | 小件剔除模式,0,模型剔除模式,1,屏幕剔除模式 |
removeSize | 小件剔除百分比 |
isMultiSelect | 是否使用多选,TRUE,多选 |
loadExternInfo | 是否加载扩展数据如属性、动画等 |
loadBoundaryLine | 是否加载边界线 |
loadPMI | 是否加载PMI |
loadView | 是否加载视图 |
isAutoLoadChildAnimation | 是否自动加载自动画 |
isSAAutoRecordInsState | 第一次打开模型时,是否自动记录零件状态到动画中 |
useCullFace | 背面剔除:0,根据模型标志位剔除;1,关闭背面剔除;2,开启 |
backgroundTopColor | 背景色顶部颜色。 |
backgroundBottomColor | 背景色底部颜色。 |
useBackImage | 是否使用背景图片,TRUE,启用 |
backgroundImage | 背景图片路径 |
useSkybox | 使用天空盒开关,TRUE,使用天空盒 |
skyboxName | 天空盒名称 |
fieldSize | 视野范围 |
defaultSpecularity | 镜面反射度 |
selectionEffect | 选中效果:1,轮廓;3,高亮 |
设置单个SView配置
方法
void SetParameter(BSTR parName, BSTR parValue)
说明
设置单个SView配置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
parName | 是 | 参数名称 |
parValue | 是 | 参数值 |
返回值
无
备注
无
获取单个SView配置
方法
BSTR GetParameter(BSTR parName)
说明
获取单个SView配置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
parName | 是 | 参数名称 |
返回值
参数值。
备注
无
设置多个view配置
方法
void SetViewParameters(SHORT viewID, BSTR json)
说明
设置多个view配置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
json | 是 | json格式参数对 |
返回值
无
备注
无
获取多个view配置
方法
BSTR GetViewParameters(SHORT viewID)
说明
获取多个view配置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
json格式参数对。
备注
无
设置单个view配置
方法
void SetViewParameter(SHORT viewID, BSTR parName, BSTR parValue)
说明
设置单个view配置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
parName | 是 | 参数名称 |
parValue | 是 | 参数值 |
返回值
无
备注
无
获取单个view配置
方法
BSTR GetViewParameter(SHORT viewID, BSTR parName)
说明
获取单个view配置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
parName | 是 | 参数名称 |
返回值
指定参数名称的参数值。
备注
无
添加自定义工具栏
方法
VARIANT_BOOL AddToolbarItem(BSTR toolbarItem)
说明
添加自定义工具栏。
参数
参数 | 是否必须 | 说明 |
---|---|---|
toolbarItem | 是 | 工具栏信息 |
返回值
TRUE, 添加成功。
备注
无
删除自定义工具栏
方法
VARIANT_BOOL RemoveToolbar(BSTR toolbarID)
说明
删除自定义工具栏。
参数
参数 | 是否必须 | 说明 |
---|---|---|
toolbarID | 是 | 工具栏ID |
返回值
TRUE,删除成功。
备注
无
获取视口
方法
BSTR GetView(BSTR viewName)
说明
获取指定名称的视口的ID。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewName | 是 | 视口名称 |
返回值
视口ID。
备注
无
显示提示
方法
BSTR ShowMsgBox(SHORT type, BSTR title, BSTR msg)
说明
格式化MessageBox的显示,按照指定规格显示。
参数
参数 | 是否必须 | 说明 |
---|---|---|
type | 是 | 提示类型:1.消息提示,2警告,3提醒,4询问(是否),5询问(是/否/取消) |
title | 是 | 提示标题 |
msg | 是 | 提示内容 |
返回值
TRUE,成功显示。
备注
无
读取svlx
方法
BSTR GetSVLXFile(SHORT viewID, BSTR extName)
说明
在当前svlx模型中以文本方式读取指定扩展名的文件,返回文件内容。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
filePath | 是 | 文件扩展名 |
返回值
文本内容。
备注
无
写入svlx
方法
VARIANT_BOOL AddSVLXFile(SHORT viewID, BSTR filePath)
说明
将指定文件添加到svlx模型内。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
filePath | 是 | 文件全路径 |
返回值
TRUE,添加成功。
备注
无
查找svlx
方法
VARIANT_BOOL FindSVLXFile(SHORT viewID, BSTR extName)
说明
在当前svlx模型中查找是否含有指定扩展名的文件。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
extName | 是 | 文件扩展名 |
返回值
TRUE,查找到文件。
备注
无
删除svlx
方法
VARIANT_BOOL RemoveSVLXFile(SHORT viewID, BSTR extName)
说明
在当前svlx模型中删除指定扩展名的文件。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
extName | 是 | 文件扩展名 |
返回值
TRUE,删除成功。
备注
无
恢复颜色
方法
VARIANT_BOOL RestoreColor(SHORT viewID, BSTR shapeIDs, SHORT shapType)
说明
恢复指定类型指定ID的对象的颜色。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
shapeIDs | 是 | 对象ID集合,由“;”隔开。 |
shapType | 是 | 对象类型,如:1=批注、2=测量、 3=PMI、4=热点、5=几何等 |
返回值
TRUE,恢复颜色成功。
备注
无
恢复模型颜色
方法
VARIANT_BOOL RestoreModelColor(SHORT viewID, BSTR plcPaths)
说明
恢复指定配置路径模型的颜色。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPaths | 是 | 模型配置路径集合,由“;”隔开。 |
返回值
TRUE,恢复颜色成功。
备注
无
拾取屏幕对象
方法
VARIANT_BOOL SelectShape(SHORT viewID, FLOAT x, FLOAT y, SHORT type)
说明
拾取指定屏幕点上的对象。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
x | 是 | 屏幕点x坐标。 |
y | 是 | 屏幕点y坐标。 |
type | 是 | 拾取类型:0=顶点,1=边,2=面,3=体,4=模型。 |
返回值
对象ID。
备注
无
设置随机色
方法
VARIANT_BOOL SetModelRandomColor(SHORT viewID)
说明
设置随机色。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
TRUE,设置成功。
备注
无
设置摄像机显隐状态
方法
VARIANT_BOOL SetCameraVisible(SHORT viewID, BSTR cameraName, VARIANT_BOOL visible)
说明
设置摄像机显隐状态。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
cameraName | 是 | 摄像机名称 |
visible | 是 | 显隐状态 |
返回值
TRUE,设置成功。
备注
无
获取摄像机显隐状态
方法
VARIANT_BOOL GetCameraVisible(SHORT viewID, BSTR cameraName)
说明
获取摄像机显隐状态。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
cameraName | 是 | 摄像机名称 |
返回值
TRUE,显示,否则,隐藏。
备注
无
设置摄像机向上方向
方法
void SetUpDirection(SHORT viewID, SHORT axis)
说明
设置摄像机向上方向。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
axis | 是 | 0,右方向;1,左方向;2,上方向;3,下方向;4,前方向;5,后方向 |
返回值
无
备注
无
设置模型居中显示
方法
void FocusModel(SHORT viewID, BSTR plcPath)
说明
设置模型居中显示。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
无
备注
无
设置滚轮方向
方法
void SetWheelDirection(SHORT viewID, SHORT direction)
说明
设置滚轮方向。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
direction | 是 | 滚轮方向:1,后滚放大;2,前滚放大。 |
返回值
无
备注
无
执行操作
方法
SHORT DoActions(SHORT viewID, BSTR actionJson)
说明
根据json串格式的action,执行指定操作,见https://docs.qq.com/sheet/DZXdtV3ZpVnVSZWtF?tab=BB08J2&c=H3A0C0。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
actionJson | 是 | json格式的action动作。 |
返回值
异常码,如表所示:
名称 | 值 | 说明 |
---|---|---|
M_Read_IO_ERROR | 203 | 函数错误 |
M_Read_ANALYSIS_ERROR | 205 | 文件解析失败 |
Action_Success | 1000 | 响应成功 |
备注
无
执行命令
方法
SHORT DoCommands(SHORT viewID, BSTR commandJson)
说明
根据json串格式的command,执行指定命令,见https://docs.qq.com/sheet/DZXdtV3ZpVnVSZWtF?tab=BB08J2&c=H3A0C0。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
commandJson | 是 | json格式的command命令。 |
返回值
异常码,见DoAction接口。
备注
无
装配
插入装配
方法
BSTR InsertBomTo(SHORT viewID, BSTR filePath, BSTR parentPath)
说明
插入模型,将指定模型打开并插入到指定父装配下,放在尾部。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
filePath | 是 | 插入的模型文件路径 |
parentPath | 是 | 父对象配置路径,如:PATH|0|3 |
返回值
新增模型配置路径。
备注
无
删除装配
方法
void RemoveBom(SHORT viewID, BSTR plcPath)
说明
删除装配
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配路径,多个中间用 ";"分割(如:PATH|0|2;PATH|0|5) |
返回值
无
备注
无
导出BOM装配结构
方法
BSTR ToBomJson(SHORT viewID)
说明
导出BOM装配结构
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
装配的BOM结构,json格式。
备注
无
重命名装配
方法
VARIANT_BOOL SetModelName(SHORT viewID, BSTR plcPath, BSTR newName)
说明
重命名装配
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
newName | 是 | 装配名称 |
返回值
成功与否,成功,TRUE,否则,FALSE。
备注
无
移动装配
方法
void MoveBomTo(SHORT viewID, BSTR sourcePaths, BSTR parentPath)
说明
移动指定装配到指定父装配下,放到尾部
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
sourcePaths | 是 | 待移动装配配置路径, 配置路径集合,由“;”隔开 |
parentPath | 是 | 父装配配置路径 |
返回值
无
备注
无
创建装配
方法
BSTR CreateBom(SHORT viewID, BSTR name, BSTR parentPath)
说明
使用指定名称创建装配,并放到指定父装配尾部
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
name | 是 | 新装配名称 |
parentPath | 是 | 父装配配置路径 |
返回值
新建装配的配置路径。
备注
无
复制装配
方法
VARIANT_BOOL CopyBomFrom(SHORT viewID, BSTR plcPath)
说明
复制指定配置路径的装配
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
TRUE, 操作成功。
备注
无
粘贴装配
方法
BSTR PasteBomTo(SHORT viewID, BSTR parentPath)
说明
从剪切板粘贴装配到指定父装配
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
parentPath | 是 | 父装配配置路径 |
返回值
新装配的配置路径集合,由“;”隔开。
备注
无
剪切装配
方法
VARIANT_BOOL CutBomFrom(SHORT viewID, BSTR plcPath)
说明
将指定配置路径的装配剪切到剪切板
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
TRUE,剪切成功
备注
无
获取子节点
方法
BSTR GetModelSubModels(SHORT viewID, BSTR plcPath)
说明
获取指定配置路径装配的子级节点,返回子节点配置路径集合
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
子节点配置路径集合,由“;”隔开。
备注
无
平移装配
方法
void TranslateModel(SHORT viewID, BSTR plcPath, SHORT coordinateType, SHORT axial, FLOAT offset)
说明
按照指定轴,移动指定装配,指定偏移量。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
coordinateType | 是 | 参照对象 0 全局 1 零件 |
axial | 是 | 轴向 0 x轴 1 y轴 2 z轴 |
offset | 是 | 偏移量 |
返回值
无
备注
无
旋转装配
方法
void RotateModel(SHORT viewID, BSTR plcPath, SHORT coordinateType, SHORT axial, FLOAT angle)
说明
按照指定轴,旋转指定装配, 指定角度。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
coordinateType | 是 | 参照对象 0 全局 1 零件 |
axial | 是 | 轴向 0 x轴 1 y轴 2 z轴 |
angle | 是 | 角度 |
返回值
无
备注
无
获取装配相对父级装配坐标系
方法
BSTR GetRelativeCoordinate(SHORT viewID, BSTR plcPath)
说明
获取装配相对父级装配坐标系。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径,支持单个 |
返回值
中心点坐标:x轴坐标;y轴坐标;z轴坐标。
备注
无
获取装配相对坐标原点的坐标
方法
BSTR GetWorldCoordinate(SHORT viewID, BSTR plcPath)
说明
获取装配相对坐标原点的坐标。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
中心点坐标:x轴坐标;y轴坐标;z轴坐标。
备注
无
获取装配相对父级装配包围盒最大点和最小点
方法
BSTR GetWorldCoordinate(SHORT viewID, BSTR plcPath)
说明
获取装配相对父级装配包围盒最大点和最小点。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
最小最大点坐标: Max:最大x坐标;最大y坐标;最大z坐标 Min:最小x坐标;最小y坐标;最小z坐标
备注
无
获取装配相对坐标原点的包围盒的最大点和最小点
方法
BSTR GetWorldBoundingBox(SHORT viewID, BSTR plcPath)
说明
获取装配相对坐标原点的包围盒的最大点和最小点。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
最小最大点坐标: Max:最大x坐标;最大y坐标;最大z坐标 Min:最小x坐标;最小y坐标;最小z坐标
备注
无
获取指定名称的装配的路径集合
方法
BSTR GetModelPath(SHORT viewID, BSTR modelName)
说明
获取指定名称的装配的路径集合。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelName | 是 | 装配名称 |
返回值
配置路径集合,由“;”隔开。
备注
无
是否含有子装配
方法
VARIANT_BOOL IsModelAssembly(SHORT viewID, BSTR plcPath)
说明
判断指定装配是否含有子装配。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
TRUE,含有子装配。
备注
无
获取父装配路径
方法
BSTR GetModelParent(SHORT viewID, BSTR plcPath)
说明
获取指定装配的父装配配置路径。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
父装配配置路径。
备注
无
获取装配名称
方法
BSTR GetModelName(SHORT viewID, BSTR plcPath)
说明
获取装配名称。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
装配名称。
备注
无
获取装配PMI列表
方法
BSTR GetModelAllPMIs(SHORT viewID, BSTR plcPath)
说明
获取装配PMI列表。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
模型PMI的ID列表,由“;”隔开。
备注
无
恢复初始位置
方法
void RestoreModel(SHORT viewID, BSTR plcPath)
说明
恢复装配初始位置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
无
备注
无
获取装配批注列表
方法
BSTR GetModelAllNotes(SHORT viewID, BSTR plcPath)
说明
获取装配批注列表。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径,暂时只支持顶层装配(即“PATH|0”) |
返回值
批注ID列表集合,由“;”隔开。
备注
无
获取包围盒的最大值和最小值
方法
BSTR GetModelBoundingBox(SHORT viewID, BSTR plcPath)
说明
获取包围盒的最大值和最小值。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
格式为Max:x;y;z;Min:x;y;z的字符串,其中Max部分为包围盒最大值,Min部分为包围盒最小部分。
备注
无
获取模型世界坐标系位置
方法
BSTR GetModelWorldPosition(SHORT viewID, BSTR plcPath)
说明
获取模型世界坐标系位置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
json串格式的世界坐标系,如:
{
"positionX":4545,
"positionY":1142.2,
"positionZ":"-545"
}
备注
无
设置模型世界坐标系位置
方法
VARIANT_BOOL SetModelWorldPosition(SHORT viewID, BSTR plcPath, BSTR posStr)
说明
设置模型世界坐标系位置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
posStr | 是 | 格式:x坐标,y坐标,z坐标 |
返回值
TRUE,设置成功。
备注
无
获取模型的旋转信息
方法
BSTR GetModelRotationByPlcPath(SHORT viewID, BSTR plcPath)
说明
根据配置路径获取模型旋转量信息。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
plcPath | 是 | 装配配置路径 |
返回值
旋转量
备注
无
视图
获取视图列表
方法
BSTR GetModelViews(SHORT viewID)
说明
获取视图列表
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
返回值
视图ID和名称组合字符串;格式如下:ID,名称;ID,名称。
备注
无
根据视图ID设置当前视图
方法
void SetCurrentModelView(SHORT viewID, LONG modelviewID)
说明
根据视图ID设置当前视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelviewID | 是 | 模型视图ID |
返回值
无
备注
无
获取当前视图ID
方法
LONG GetCurrentModelView(SHORT viewID)
说明
获取当前视图ID。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
当前视图ID。
备注
无
显示默认视图
方法
void ShowDefaultModelView(SHORT viewID)
说明
显示默认视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
刷新视口
方法
VARIANT_BOOL RefreshWindow(SHORT viewID)
说明
刷新视口
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
TRUE-成功FASLE-失败
备注
无
创建视图
方法
void CreateModelView(SHORT viewID, BSTR viewType, BSTR viewName)
说明
创建视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
viewName | 是 | 视图名称 |
viewType | 是 | 0,摄像机视图,只记录摄像机状态; 1,记录摄像机和零件状态(位置、显隐); 2,记录零件的位置和显隐状态。 |
返回值
无
备注
无
删除视图
方法
void RemoveModelView(SHORT viewID, BSTR modelviewIDs)
说明
创建视图
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelviewIDs | 是 | 模型视图ID集合,由“;”隔开 |
返回值
无
备注
无
播放视图
方法
void PlayModelView(SHORT viewID)
说明
在自定义视图之间使用动画效果切换。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
停止播放视图
方法
void StopModelView(SHORT viewID)
说明
停止在自定义视图之间使用动画效果切换。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
设置默认视图
方法
void SetDefaultModelView(SHORT viewID, LONG modelviewID)
说明
设置指定ID的视图为默认视图。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelviewID | 是 | 模型视图ID |
返回值
无
备注
无
获取默认视图
方法
LONG GetDefaultModelView(SHORT viewID)
说明
获取默认视图的ID。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
视图ID。
备注
无
获取视图关联的PMI
方法
BSTR GetModelViewPMIs(SHORT viewID, LONG modelViewID)
说明
获取视图关联的PMI。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelViewID | 是 | 模型视图ID |
返回值
pmiID数组字符串,由“;”隔开。
备注
无
获取视图关联的剖切
方法
BSTR GetModelViewClips(SHORT viewID, LONG modelViewID)
说明
获取视图关联的剖切。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelViewID | 是 | 模型视图ID |
返回值
剖切ID字符串,由“;”隔开。
备注
无
获取视图关联的批注
方法
BSTR GetModelViewNotes(SHORT viewID, LONG modelViewID)
说明
获取视图关联的批注。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelViewID | 是 | 模型视图ID |
返回值
批注ID字符串,由“;”隔开。
备注
无
获取视图关联的模型
方法
BSTR GetModelViewModels(SHORT viewID, LONG modelViewID)
说明
获取视图关联的模型。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelViewID | 是 | 模型视图ID |
返回值
模型配置路径集合字符串,由“;”隔开。
备注
无
切换视图
方法
void ShowModelView(SHORT viewID, BSTR viewName, VARIANT_BOOL bAnimationPlay)
说明
切换到指定名称的视图。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
viewName | 是 | 模型视图名称 |
bAnimationPlay | 是 | 是否使用动画效果,TRUE, 采用动画效果。 |
返回值
无
备注
无
保存视图为Json串
方法
BSTR ToModelViewJson(SHORT viewID, BSTR modelviewIDs)
说明
保存视图为Json串。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelviewIDs | 是 | 模型视图id集合,由“;”隔开 |
返回值
视图json串。
备注
无
从Json串添加视图
方法
BSTR FromModelViewJson(SHORT viewID, BSTR modelviewJson)
说明
从Json串添加视图。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
modelviewJson | 是 | 模型视图json串 |
返回值
模型视图id集合,由“;”隔开。
备注
无
动画
播放动画
方法
void PlayAnimation(SHORT viewID, LONG playMode, VARIANT_BOOL bReverse)
说明
播放动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
playMode | 是 | 0-无 1-播放当前步骤 2-从当前步骤开始播放 3-播放当前过程 4-从当前过程开始播放 5-播放全部动画 |
bReverse | 是 | 是否为倒播 |
返回值
无
备注
无
创建新的步骤
方法
BSTR CreateAnimationStep(SHORT viewID, BSTR stepName, VARIANT_BOOL bRecCamState, VARIANT_BOOL bRecInsState, VARIANT_BOOL bRecOnlySelectedInsState)
说明
创建新的步骤
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
stepName | 是 | 步骤名称 |
bRecCamState | 是 | 是否录制摄像机状态 |
bRecInsState | 是 | 是否记录实例状态 |
bRecOnlySelectedInsState | 是 | 是否只记录选中实例状态 |
返回值
步骤ID,如:0|1(0代表过程ID,1代表步骤ID)
备注
无
删除指定步骤ID的动画
方法
void RemoveAnimationStep(SHORT viewID, BSTR stepID)
说明
删除指定步骤ID的动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
stepID | 是 | 由过程ID和步骤ID组成,如:0|1(0代表过程ID,1代表步骤ID) |
返回值
无
备注
无
设置成当前活动的步骤
方法
void SetAnimationCurStep(SHORT viewID, BSTR stepID)
说明
设置成当前活动的步骤
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
stepID | 是 | 由过程ID和步骤ID组成,如:0|1(0代表过程ID,1代表步骤ID) |
返回值
无
备注
无
更新当前步骤
方法
void UpdateAnimationCurStep(SHORT viewID, BSTR stepID)
说明
更新当前步骤
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
stepID | 是 | 由过程ID和步骤ID组成,如:0|1(0代表过程ID,1代表步骤ID) |
返回值
无
备注
无
暂停播放动画
方法
void PauseAnimation(SHORT viewID)
说明
暂停播放动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
继续播放动画
方法
void ContinueAnimation(SHORT viewID)
说明
继续播放动画
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
设置动画参数
方法
void SetAnimationParameter(SHORT viewID, BSTR parName, BSTR parValue)
说明
设置动画参数
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
parName | 是 | 参数名称 |
parValue | 是 | 参数值 |
返回值
无
备注
无
倒带
方法
void RewindAnimation(SHORT viewID)
说明
倒带
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
无
备注
无
是否正在播放
方法
VARIANT_BOOL IsPlayingAnimation(SHORT viewID)
说明
判断动画是否正在播放
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
是否正在播放。
备注
无
是否存在动画
方法
VARIANT_BOOL ExistAnimation(SHORT viewID)
说明
判断模型是否存在动画。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
模型是否含有动画。
备注
无
获取当前活动动画
方法
BSTR GetAnimationCurStep(SHORT viewID)
说明
获取当前活动动画。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
当前动画ID,格式“过程ID|步骤ID”。
备注
无
添加动画路径
方法
LONG AddPath(SHORT viewID, BSTR pathJson)
说明
添加动画路径。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
pathJson | 是 | 路径信息json串。格式:"{\"name\":\"相机路径1\",\"lineType\":0,\"points\":[[-2209.494141, 772.971313, 744.182739],[-1872.476807, 33.929382, 1013.258667],[-1068.527100, -193.967957, 931.304199],[42.253601, -288.003662, 703.625732],[1509.554443, 32.314880, 184.580322]]}。 释义:name:路径名称;lineType:线型,0,折线,1,曲线;points:点的集合。 |
返回值
路径ID。
备注
无
播放路径动画
方法
SHORT PathAnimation(SHORT viewID, BSTR pathAnimationJson)
说明
播放路径动画。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
pathAnimationJson | 是 | 播放路径动画json串。格式:{\"pathID\":1001,\"objectPath\":\"PATH|0|1\",\"reverse\":false}。 释义:pathID:路径ID;objectPath:对象路径,传入"",相机沿路径移动;传入模型ID(格式为PATH|0|a),模型沿路径移动, reverse:是否反向移动。 |
返回值
路径ID。
备注
无
获取子动画信息
方法
BSTR GetChildAniInfoByPlcPath(SHORT viewID, BSTR plcPath)
说明
根据配置路径获取子件动画信息。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
pathAnimationJson | 是 | 子件的配置路径,参数不为""时获取子件动画信息;传""时获取所有动画信息 |
返回值
过程ID1|步骤ID1;过程ID2|步骤ID2
备注
无
PMI
获取PMI相关信息
方法
BSTR GetPMIInfo(SHORT viewID, BSTR name)
说明
根据PMI类型名称获取该类型所有PMI
参数
参数 | 是否必须 | 说明 |
---|---|---|
propertyName | 是 | PMI类型名称 "COMPONENT_SN"代表零件序号PMI名称;"TORQUE"代表扭矩PMI名称;"GAP"表示间隙;""获取所有PMI信息 |
返回值
总装下所有该类型的PMI,格式为"配置路径1:PMI名称;配置路径2:PMI名称2"。当输入为"",获取所有PMI信息,格式为"id:内容,显隐状态;id:内容,显隐状态"。多行文本用"\r\n"分割
备注
目前,只支持“COMPONENT_SN”类型和“”
热点
创建热点
方法
BSTR CreateHotSpot(SHORT viewID, BSTR locationX, BSTR locationY, BSTR name, BSTR des)
说明
创建热点
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视图ID |
locationX | 是 | 屏幕点x坐标 |
locationY | 是 | 屏幕点y坐标 |
name | 是 | 热点名称 |
des | 是 | 热点描述 |
返回值
创建的热点ID。
备注
无
删除热点
方法
VARIANT_BOOL RemoveHotSpot(SHORT viewID, BSTR hotSpotId)
说明
删除热点
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
hotSpotId | 是 | 热点ID,只支持单个 |
返回值
TRUE-成功FASLE-失败
备注
无
热点关联视图
方法
VARIANT_BOOL SetHotspotModelView(SHORT viewID, BSTR hotspotID, BSTR modelviewID)
说明
设置热点关联的视图。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
hotSpotId | 是 | 热点ID,只支持单个 |
modelviewID | 是 | 视图ID,只支持单个 |
返回值
TRUE-成功FASLE-失败
备注
无
热点关联声音
方法
VARIANT_BOOL SetHotspotVoice(SHORT viewID, BSTR hotspotID, BSTR voiceFilePath)
说明
设置热点关联的声音文件。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
hotSpotId | 是 | 热点ID,只支持单个 |
voiceFilePath | 是 | 声音文件路径 |
返回值
TRUE-成功FASLE-失败
备注
无
反序列化热点
方法
BSTR FromHotspotJson(SHORT viewID, BSTR json)
说明
反序列化热点
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
json | 是 | 热点json串。 |
返回值
生成的热点ID集合,由“;”隔开。
备注
无
设置热点图标
事件
VARIANT_BOOL SetHotspotImage(SHORT viewID, BSTR hotspotID, BSTR imagePath)
说明
设置热点图标
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
hotspotID | 是 | 热点id集合,由“;”隔开。 |
imagePath | 是 | 热点图标文件路径。 |
返回值
TRUE,设置成功。
备注
无
批注
更新用户信息
方法
void UpdateSViewUser(BSTR userJson)
说明
设置当前选中批注的用户信息
参数
参数 | 是否必须 | 说明 |
---|---|---|
userJson | 是 | 用户信息,json格式 { "username":"asheishei", "department":"Development", "role":"Programmer" } |
返回值
无
备注
无
获取用户信息
方法
BSTR GetUser(void)
说明
获取当前选中批注的用户信息
参数
无
返回值
用户名;部门名称;开发
备注
无
序列化指定批注到json
方法
BSTR ToNoteJson(SHORT viewID, BSTR noteIDs)
说明
序列化指定批注到json。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
noteIDs | 是 | 批注id集合,由“;”隔开 |
返回值
批注json串。
备注
无
反序列化批注
方法
BSTR FromNoteJson(SHORT viewID, BSTR noteJson)
说明
反序列化批注。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
noteJson | 是 | 批注json串 |
返回值
批注id集合,由“;”隔开。
备注
无
删除批注
方法
VARIANT_BOOL RemoveNote(SHORT viewID, BSTR noteIds)
说明
删除批注
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
noteIds | 是 | 批注ID,多个用';'间隔 |
成功与否
void
备注
无
剖切
创建剖切
方法
VARIANT_BOOL CreateClip(SHORT viewID, BSTR clipJson)
说明
使用json创建剖切。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
clipJson | 是 | json格式如: { "name":"fsf", "direction":1, "position":23.5, "showClipPlane":false, "showCutPlane":false, "reverseClip":false } |
返回值
TRUE:创建成功。
备注
无
删除剖切
方法
VARIANT_BOOL RemoveClip(SHORT viewID, LONG clipID)
说明
根据剖切ID删除指定剖切。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
clipID | 是 | 剖切ID |
返回值
TRUE:删除成功。
备注
无
设置剖切
方法
VARIANT_BOOL Clip(SHORT viewID, BSTR json)
说明
根据json串设置剖切。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
json | 是 | 格式如: { "direction":1, "position":23.5, "showClipPlane":false, "showCutPlane":false, "reverseClip":false } |
返回值
TRUE:设置成功。
备注
无
设置多面剖
方法
VARIANT_BOOL MultiClip(SHORT viewID, BSTR json)
说明
根据json串设置多面剖。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
json | 是 | 格式如: { "directionX": 1, "positionX": 50, "directionY": 1, "positionY": 0, "directionZ": 1, "positionZ": 10, "showClipPlane": false, "showCutPlane": true, "reverseClip": false } |
返回值
TRUE:设置成功。
备注
无
取消剖切
方法
VARIANT_BOOL CancelClip(SHORT viewID)
说明
取消剖切的设置。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
返回值
TRUE:取消设置成功。
备注
无
测量
序列化测量对象
方法
BSTR FromMeasureJson(SHORT viewID, BSTR measureJson)
说明
序列化测量对象。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
measureJson | 是 | 测量对象的json格式 |
返回值
测量对象的ID集合,由“;”隔开。
备注
无
删除测量
方法
VARIANT_BOOL RemoveMeasure(SHORT viewID, BSTR measureIDs)
说明
删除测量对象。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
measureIDs | 是 | 测量对象的ID集合,由“;”隔开 |
返回值
TRUE,删除成功。
备注
无
反序列化测量对象
方法
BSTR ToMeasureJson(SHORT viewID, BSTR measureIDs)
说明
反序列化测量对象。
参数
参数 | 是否必须 | 说明 |
---|---|---|
viewID | 是 | 视口ID |
measureIDs | 是 | 测量对象的ID集合,由“;”隔开 |
返回值
测量对象的json格式。
备注
无
事件
选中模型事件
事件
void OnModelSelectedChanged(BSTR svlPath, VARIANT_BOOL isSelected)
说明
选中模型事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
svlPath | 是 | 拾取零件的配置路径 |
isSelected | 是 | 拾取或取消拾取 |
返回值
无
备注
无
鼠标事件
事件
void OnMouseEven(int mouseKey)
说明
鼠标事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
mouseKey | 是 |
1-单击左键 2-单击右键 3-双击左键 4-双击右键 |
返回值
无
备注
读取完模型触发
事件
void OnReadEndEvent(BSTR fileLoadInfo)
说明
打开文件后触发事件
参数
参数 | 是否必须 | 说明 |
---|---|---|
fileLoadInfo | 是 | svlx文件路径 |
返回值
无
备注
无
创建零组件标注前事件
事件
void OnCreateCompNameBeginEvent()
说明
创建零组件标注前事件,在执行创建零组件标注时,创建标注前触发。
参数
无
返回值
无
备注
在执行工具栏标记命令"零组件"时响应。
创建零组件序号标注前事件
事件
void OnCreateSerialNumberBeginEvent()
说明
创建零组件序号标注前事件,在执行创建零组件序号标注时,创建序号前触发。
参数
无
返回值
无
备注
在执行工具栏标记命令"序号"时响应。
选中PMI事件
事件
void OnPMISelectedChanged(INT iPMIId)
说明
选中PMI时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
iPMIId | 是 | pmi ID |
返回值
无
备注
在选择PMI时响应的事件处理。
完成距离创建事件
事件
void OnCreateMeasureEndEvent(BSTR strGUID)
说明
选中PMI时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
strGUID | 是 | 测量对象的GUID |
返回值
无
备注
在完成测量的标记后触发。
动画步骤开始播放事件
事件
void OnPlayBeginEvent(INT iProcessID, INT iStepID)
说明
动画步骤开始播放时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
iProcessID | 是 | 过程ID |
iStepID | 是 | 步骤ID |
返回值
无
备注
动画步骤开始播放时触发。
action执行开始事件
事件
void OnActionExecuteBeforeEvent(BSTR strInfo)
说明
action执行开始时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
strInfo | 是 | action信息 |
返回值
无
备注
action执行开始时触发。
action执行结束事件
事件
void OnActionExecuteAfterEvent(BSTR strInfo)
说明
action执行结束时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
strInfo | 是 | action信息 |
返回值
无
备注
action执行结束时触发。
command执行开始事件
事件
void OnCommandExecuteBeforeEvent(BSTR strInfo)
说明
command执行开始时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
strInfo | 是 | command信息 |
返回值
无
备注
command执行开始时触发。
command执行结束事件
事件
void OnCommandExecuteAfterEvent(BSTR strInfo)
说明
command执行结束时触发
参数
参数 | 是否必须 | 说明 |
---|---|---|
strInfo | 是 | command信息 |
返回值
无
备注
command执行结束时触发。